-
Account Access
-
Account Access governs access to Bank Accounts by end Users. It is an intersecting entity between tMore...
- Create Account Access Consents
- Delete Account Access Consents
- Get Account Access Consents
-
-
Account Access
-
Accounts
-
Balances
-
Beneficiaries
-
Direct Debits
-
Domestic Payments
- Create Domestic Payment Consents
- Create Domestic Payments
- Get Domestic Payment Consents
- Get Domestic Payment Consents Funds Confirmation
- Get Domestic Payments
-
Domestic Scheduled Payments
- Create Domestic Scheduled Payment Consents
- Create Domestic Scheduled Payments
- Get Domestic Scheduled Payment Consents
- Get Domestic Scheduled Payments
-
Domestic Standing Orders
- Create Domestic Standing Order Consents
- Create Domestic Standing Orders
- Get Domestic Standing Order Consents
- Get Domestic Standing Orders
-
Dynamic Resource Doc
-
File Payments
- Create File Payment Consents
- Create File Payment Consents
- Create File Payments
- Get File Payment Consents
- Get File Payment Consents
- Get File Payments
- Get File Payments
-
Funds Confirmations
- Create Funds Confirmation
- Create Funds Confirmation Consent
- Delete Funds Confirmation Consent
- Get Funds Confirmation Consent
-
International Payments
- Create International Payment Consents
- Create International Payments
- Get International Payment Consents
- Get International Payment Consents Funds Confirmation
- Get International Payments
-
International Scheduled Payments
- Create International Scheduled Payment Consents
- Create International Scheduled Payments
- Get International Scheduled Payment Consents
- Get International Scheduled Payment Consents Funds Confirmation
- Get International Scheduled Payments
-
International Standing Orders
- Create International Standing Order Consents
- Create International Standing Orders
- Get International Standing Order Consents
- Get International Standing Orders
-
Offers
-
Partys
-
Products
-
Scheduled Payments
-
Standing Orders
-
Statements
-
Transactions
v3.1 (67 APIs)
API Host: https://obp-api-sandbox.nmbbank.co.tz
Bank
Accounts
Views
Counterparties
Transactions
Create International Standing Order Consents
NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
JSON request body fields:
JSON response body fields:
Typical Successful Response:
{
"Meta":{
"FirstAvailableDateTime":{
},
"TotalPages":0
},
"Risk":{
"PaymentContextCode":{
},
"DeliveryAddress":{
"StreetName":"StreetName",
"CountrySubDivision":["CountrySubDivision","CountrySubDivision"],
"AddressLine":["AddressLine","AddressLine"],
"BuildingNumber":"BuildingNumber",
"TownName":"TownName",
"Country":"Country",
"PostCode":"PostCode"
},
"MerchantCategoryCode":"MerchantCategoryCode",
"MerchantCustomerIdentification":"MerchantCustomerIdentification"
},
"Links":{
"Last":"http://example.com/aeiou",
"Prev":"http://example.com/aeiou",
"Next":"http://example.com/aeiou",
"Self":"http://example.com/aeiou",
"First":"http://example.com/aeiou"
},
"Data":{
"Status":{
},
"StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00",
"CreationDateTime":"2000-01-23T04:56:07.000+00:00",
"CutOffDateTime":"2000-01-23T04:56:07.000+00:00",
"Authorisation":{
"CompletionDateTime":"2000-01-23T04:56:07.000+00:00",
"AuthorisationType":{
}
},
"Permission":{
},
"Charges":[{
"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],
"Amount":{
"Amount":{
},
"Currency":"Currency"
},
"ChargeBearer":{
}
},{
"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],
"Amount":{
"Amount":{
},
"Currency":"Currency"
},
"ChargeBearer":{
}
}],
"ConsentId":"ConsentId",
"Initiation":{
"SupplementaryData":{
},
"DebtorAccount":{
"SecondaryIdentification":"SecondaryIdentification",
"SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],
"Identification":"Identification",
"Name":"Name"
},
"CreditorAgent":{
"PostalAddress":{
"StreetName":"StreetName",
"CountrySubDivision":"CountrySubDivision",
"Department":"Department",
"AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],
"BuildingNumber":"BuildingNumber",
"TownName":"TownName",
"Country":"Country",
"SubDepartment":"SubDepartment",
"AddressType":{
},
"PostCode":"PostCode"
},
"SchemeName":["UK.OBIE.BICFI"],
"Identification":"Identification",
"Name":"Name"
},
"Reference":"Reference",
"CurrencyOfTransfer":"CurrencyOfTransfer",
"CreditorAccount":{
"SecondaryIdentification":"SecondaryIdentification",
"SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],
"Identification":"Identification",
"Name":"Name"
},
"Purpose":{
},
"ChargeBearer":{
},
"FinalPaymentDateTime":"2000-01-23T04:56:07.000+00:00",
"Frequency":"Frequency",
"FirstPaymentDateTime":"2000-01-23T04:56:07.000+00:00",
"NumberOfPayments":"NumberOfPayments",
"Creditor":{
"PostalAddress":{
"StreetName":"StreetName",
"CountrySubDivision":"CountrySubDivision",
"Department":"Department",
"AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],
"BuildingNumber":"BuildingNumber",
"TownName":"TownName",
"Country":"Country",
"SubDepartment":"SubDepartment",
"AddressType":{
},
"PostCode":"PostCode"
},
"Name":"Name"
},
"InstructedAmount":{
"Currency":"Currency"
}
}
}
}
Validations:
- Required JSON Validation: No
- Allowed Authentication Types: Not set
Possible Errors:
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Connector Methods:
Version: UKv3.1,
function_name: by createInternationalStandingOrderConsents, operation_id: UKv3.1-createInternationalStandingOrderConsents
Tags: International Standing Orders, Mocked-Data,
Create International Standing Orders
NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
JSON request body fields:
JSON response body fields:
Typical Successful Response:
{
"Meta":{
"FirstAvailableDateTime":{
},
"TotalPages":0
},
"Links":{
"Last":"http://example.com/aeiou",
"Prev":"http://example.com/aeiou",
"Next":"http://example.com/aeiou",
"Self":"http://example.com/aeiou",
"First":"http://example.com/aeiou"
},
"Data":{
"Status":{
},
"StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00",
"CreationDateTime":"2000-01-23T04:56:07.000+00:00",
"Charges":[{
"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],
"Amount":{
"Amount":{
},
"Currency":"Currency"
},
"ChargeBearer":{
}
},{
"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],
"Amount":{
"Amount":{
},
"Currency":"Currency"
},
"ChargeBearer":{
}
}],
"InternationalStandingOrderId":"InternationalStandingOrderId",
"ConsentId":"ConsentId",
"Initiation":{
"SupplementaryData":{
},
"DebtorAccount":{
"SecondaryIdentification":"SecondaryIdentification",
"SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],
"Identification":"Identification",
"Name":"Name"
},
"CreditorAgent":{
"PostalAddress":{
"StreetName":"StreetName",
"CountrySubDivision":"CountrySubDivision",
"Department":"Department",
"AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],
"BuildingNumber":"BuildingNumber",
"TownName":"TownName",
"Country":"Country",
"SubDepartment":"SubDepartment",
"AddressType":{
},
"PostCode":"PostCode"
},
"SchemeName":["UK.OBIE.BICFI"],
"Identification":"Identification",
"Name":"Name"
},
"Reference":"Reference",
"CurrencyOfTransfer":"CurrencyOfTransfer",
"CreditorAccount":{
"SecondaryIdentification":"SecondaryIdentification",
"SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],
"Identification":"Identification",
"Name":"Name"
},
"Purpose":{
},
"ChargeBearer":{
},
"FinalPaymentDateTime":"2000-01-23T04:56:07.000+00:00",
"Frequency":"Frequency",
"FirstPaymentDateTime":"2000-01-23T04:56:07.000+00:00",
"NumberOfPayments":"NumberOfPayments",
"Creditor":{
"PostalAddress":{
"StreetName":"StreetName",
"CountrySubDivision":"CountrySubDivision",
"Department":"Department",
"AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],
"BuildingNumber":"BuildingNumber",
"TownName":"TownName",
"Country":"Country",
"SubDepartment":"SubDepartment",
"AddressType":{
},
"PostCode":"PostCode"
},
"Name":"Name"
},
"InstructedAmount":{
"Currency":"Currency"
}
},
"MultiAuthorisation":{
"Status":{
},
"NumberReceived":6,
"LastUpdateDateTime":"2000-01-23T04:56:07.000+00:00",
"ExpirationDateTime":"2000-01-23T04:56:07.000+00:00",
"NumberRequired":0
}
}
}
Validations:
- Required JSON Validation: No
- Allowed Authentication Types: Not set
Possible Errors:
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Connector Methods:
Version: UKv3.1,
function_name: by createInternationalStandingOrders, operation_id: UKv3.1-createInternationalStandingOrders
Tags: International Standing Orders, Mocked-Data,
Get International Standing Order Consents
NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
URL Parameters:
CONSENTID: CONSENTID
JSON response body fields:
Typical Successful Response:
{
"Meta":{
"FirstAvailableDateTime":{
},
"TotalPages":0
},
"Risk":{
"PaymentContextCode":{
},
"DeliveryAddress":{
"StreetName":"StreetName",
"CountrySubDivision":["CountrySubDivision","CountrySubDivision"],
"AddressLine":["AddressLine","AddressLine"],
"BuildingNumber":"BuildingNumber",
"TownName":"TownName",
"Country":"Country",
"PostCode":"PostCode"
},
"MerchantCategoryCode":"MerchantCategoryCode",
"MerchantCustomerIdentification":"MerchantCustomerIdentification"
},
"Links":{
"Last":"http://example.com/aeiou",
"Prev":"http://example.com/aeiou",
"Next":"http://example.com/aeiou",
"Self":"http://example.com/aeiou",
"First":"http://example.com/aeiou"
},
"Data":{
"Status":{
},
"StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00",
"CreationDateTime":"2000-01-23T04:56:07.000+00:00",
"CutOffDateTime":"2000-01-23T04:56:07.000+00:00",
"Authorisation":{
"CompletionDateTime":"2000-01-23T04:56:07.000+00:00",
"AuthorisationType":{
}
},
"Permission":{
},
"Charges":[{
"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],
"Amount":{
"Amount":{
},
"Currency":"Currency"
},
"ChargeBearer":{
}
},{
"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],
"Amount":{
"Amount":{
},
"Currency":"Currency"
},
"ChargeBearer":{
}
}],
"ConsentId":"ConsentId",
"Initiation":{
"SupplementaryData":{
},
"DebtorAccount":{
"SecondaryIdentification":"SecondaryIdentification",
"SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],
"Identification":"Identification",
"Name":"Name"
},
"CreditorAgent":{
"PostalAddress":{
"StreetName":"StreetName",
"CountrySubDivision":"CountrySubDivision",
"Department":"Department",
"AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],
"BuildingNumber":"BuildingNumber",
"TownName":"TownName",
"Country":"Country",
"SubDepartment":"SubDepartment",
"AddressType":{
},
"PostCode":"PostCode"
},
"SchemeName":["UK.OBIE.BICFI"],
"Identification":"Identification",
"Name":"Name"
},
"Reference":"Reference",
"CurrencyOfTransfer":"CurrencyOfTransfer",
"CreditorAccount":{
"SecondaryIdentification":"SecondaryIdentification",
"SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],
"Identification":"Identification",
"Name":"Name"
},
"Purpose":{
},
"ChargeBearer":{
},
"FinalPaymentDateTime":"2000-01-23T04:56:07.000+00:00",
"Frequency":"Frequency",
"FirstPaymentDateTime":"2000-01-23T04:56:07.000+00:00",
"NumberOfPayments":"NumberOfPayments",
"Creditor":{
"PostalAddress":{
"StreetName":"StreetName",
"CountrySubDivision":"CountrySubDivision",
"Department":"Department",
"AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],
"BuildingNumber":"BuildingNumber",
"TownName":"TownName",
"Country":"Country",
"SubDepartment":"SubDepartment",
"AddressType":{
},
"PostCode":"PostCode"
},
"Name":"Name"
},
"InstructedAmount":{
"Currency":"Currency"
}
}
}
}
Validations:
- Required JSON Validation: No
- Allowed Authentication Types: Not set
Possible Errors:
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Connector Methods:
Version: UKv3.1,
function_name: by getInternationalStandingOrderConsentsConsentId, operation_id: UKv3.1-getInternationalStandingOrderConsentsConsentId
Tags: International Standing Orders, Mocked-Data,
Get International Standing Orders
NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
URL Parameters:
INTERNATIONALSTANDINGORDERPAYMENTID: INTERNATIONALSTANDINGORDERPAYMENTID
JSON response body fields:
Typical Successful Response:
{
"Meta":{
"FirstAvailableDateTime":{
},
"TotalPages":0
},
"Links":{
"Last":"http://example.com/aeiou",
"Prev":"http://example.com/aeiou",
"Next":"http://example.com/aeiou",
"Self":"http://example.com/aeiou",
"First":"http://example.com/aeiou"
},
"Data":{
"Status":{
},
"StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00",
"CreationDateTime":"2000-01-23T04:56:07.000+00:00",
"Charges":[{
"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],
"Amount":{
"Amount":{
},
"Currency":"Currency"
},
"ChargeBearer":{
}
},{
"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],
"Amount":{
"Amount":{
},
"Currency":"Currency"
},
"ChargeBearer":{
}
}],
"InternationalStandingOrderId":"InternationalStandingOrderId",
"ConsentId":"ConsentId",
"Initiation":{
"SupplementaryData":{
},
"DebtorAccount":{
"SecondaryIdentification":"SecondaryIdentification",
"SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],
"Identification":"Identification",
"Name":"Name"
},
"CreditorAgent":{
"PostalAddress":{
"StreetName":"StreetName",
"CountrySubDivision":"CountrySubDivision",
"Department":"Department",
"AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],
"BuildingNumber":"BuildingNumber",
"TownName":"TownName",
"Country":"Country",
"SubDepartment":"SubDepartment",
"AddressType":{
},
"PostCode":"PostCode"
},
"SchemeName":["UK.OBIE.BICFI"],
"Identification":"Identification",
"Name":"Name"
},
"Reference":"Reference",
"CurrencyOfTransfer":"CurrencyOfTransfer",
"CreditorAccount":{
"SecondaryIdentification":"SecondaryIdentification",
"SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],
"Identification":"Identification",
"Name":"Name"
},
"Purpose":{
},
"ChargeBearer":{
},
"FinalPaymentDateTime":"2000-01-23T04:56:07.000+00:00",
"Frequency":"Frequency",
"FirstPaymentDateTime":"2000-01-23T04:56:07.000+00:00",
"NumberOfPayments":"NumberOfPayments",
"Creditor":{
"PostalAddress":{
"StreetName":"StreetName",
"CountrySubDivision":"CountrySubDivision",
"Department":"Department",
"AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],
"BuildingNumber":"BuildingNumber",
"TownName":"TownName",
"Country":"Country",
"SubDepartment":"SubDepartment",
"AddressType":{
},
"PostCode":"PostCode"
},
"Name":"Name"
},
"InstructedAmount":{
"Currency":"Currency"
}
},
"MultiAuthorisation":{
"Status":{
},
"NumberReceived":6,
"LastUpdateDateTime":"2000-01-23T04:56:07.000+00:00",
"ExpirationDateTime":"2000-01-23T04:56:07.000+00:00",
"NumberRequired":0
}
}
}
Validations:
- Required JSON Validation: No
- Allowed Authentication Types: Not set
Possible Errors:
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Connector Methods:
Version: UKv3.1,
function_name: by getInternationalStandingOrdersInternationalStandingOrderPaymentId, operation_id: UKv3.1-getInternationalStandingOrdersInternationalStandingOrderPaymentId
Tags: International Standing Orders, Mocked-Data,